home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 2.iso / files / program / comw220 / comw.txt < prev    next >
Encoding:
Text File  |  1994-07-23  |  10.3 KB  |  308 lines
  1.                                 COMW v2.20
  2.                             Communications Wait
  3.                               by John Ericson
  4. INTRODUCTION
  5.  
  6. I  originally  intended COMW to connect to my friend's system  due  to  the
  7. number  of  errors  we were having using SERSETUP.  I completed  this  task
  8. after a few evenings.  Then I thought that this would be a good opportunity
  9. to  transfer COMW updates and/or WAD files and added a streaming mode  file
  10. transfer.  By this time I had found the source for SERSETUP on  a  BBS.   I
  11. felt I could modify the protocol to make the communications faster and more
  12. reliable.   After a few more days of programming and many days  of  testing
  13. and playing, I arrived at what you see now.
  14.  
  15. OPERATIONS
  16.  
  17. Start COMW from the command line using the syntax of
  18.  
  19.      COMW SECTION1 SECTION2 SECTION3 ...
  20.  
  21. You  may  specify  one or more section names for COMW to execute  from  the
  22. COMW.INI file.  If you do not specify any section names, COMW will use  the
  23. DEFAULT section name.  Please note:  the section COMMON is always executed.
  24.  
  25. COMW.INI FORMAT
  26.  
  27. The COMW.INI file uses the following format:
  28.  
  29. [section name] comment
  30. keyword=data
  31. keyword=data
  32. keyword=data
  33. keyword=data
  34. keyword=data
  35. keyword=data
  36. [section name] comment
  37. keyword=data
  38. keyword=data
  39. keyword=data
  40. keyword=data
  41.  
  42. Section  names and keywords are not case sensitive.  You may not  have  any
  43. spaces  before the `=`.  You may use section names more than  once.   Blank
  44. lines  and  lines with invalid keywords are ignored.  COMW will not  report
  45. invalid  keywords or invalid keyword data.  COMW will process all  selected
  46. sections  twice.  The first pass is to configure all the parameters  before
  47. COMW  opens the communications port.  The second pass is for all activities
  48. using the open port.
  49.  
  50. KEYWORDS
  51.                                 First pass
  52.  
  53. com=n
  54. Default: 1
  55. Valid values: 1, 2, 3, or 4
  56.  
  57. This keyword specifies the communications port.  COMW only uses COM1, COM2,
  58. COM3, and COM4 at the standard address and hardware interrupts.
  59.  
  60. port=n
  61. Default: none
  62. Valid values: not validated
  63.  
  64. This  keyword specifies the nonstandard communications port address in  hex
  65. (i.e.  COM1 is 3f8, COM2 is 2f8).  When this keyword is specified you  must
  66. specify a IRQ setting.  An invalid address can crash your system.
  67.  
  68. irq=n
  69. Default: none
  70. Valid values: not validated
  71.  
  72. This   keyword  specifies  the  nonstandard  communications  port  hardward
  73. interrupt (I.E. COM1 is 4, COM2 is 3).  When this keyword is specified  you
  74. must  specify a PORT setting.  An invalid interrupt can crash your  system.
  75. IRQ settings of 3 through 15 are supported.
  76.  
  77. baud=n
  78. Default: 2400
  79. Valid values: speeds supported by the 8250 or 16550 UARTs
  80.  
  81. This  keyword  specifies  the communications speed for  the  communications
  82. port.   I have tested the assembler communications driver routine a  speeds
  83. from 300 to 115200 with RTS/CTS and XON/XOFF flow control.
  84.  
  85. buffer=n
  86. default: 2048
  87. Valid values: 1024-8192
  88.  
  89. This keyword specifies the number of bytes for the input and output buffers
  90. each.
  91.  
  92. flow=string
  93. Default: rdy
  94. Valid values: none, xon, rdy
  95.  
  96. This  keyword specifies the bi-directional flow control COMW uses with  the
  97. communications  port.  `none' means no flow control.  `xon' means  XON/XOFF
  98. flow control.  `rdy' means RTS/CTS or Ready/Busy flow control.
  99.  
  100. color=n
  101. Default: 112 (black on white)
  102. Valid values: 0-255
  103.  
  104. This  keyword  specifies the normal screen colors COMW uses  in  the  popup
  105. display.  The color values use the standard CGA color scheme (i.e.  1=blue,
  106. 2=green,  3=cyan,  4=red, 5=magenta, 6=yellow, 7=white, 8=high  intensity).
  107. Multiply the color by 16 to get the background colors.  Example: 1(blue)  *
  108. 16  + 8(high intensity) + 7(white) = 31.  Note: COMW enables high intensity
  109. background colors (blinking is disabled).
  110.  
  111. bcolor=n
  112. Default: 240 (black on high intensity white)
  113. Valid values: 0-255
  114.  
  115. This  keyword  specifies  the boarder color used  by  COMW  for  the  popup
  116. display.
  117.  
  118. scolor=n
  119. Default: 128 (black on high intensity black[dark gray])
  120. Valid values: 0-255
  121.  
  122. This keyword specifies the shadow color used by COMW for the popup display.
  123.  
  124. dsr=string
  125. Default: off
  126. Valid values: on, off
  127.  
  128. This  keyword  specifies whether COMW will wait for the  modem  for  remote
  129. computer to assert the DSR signal before processing keywords on the  second
  130. pass.
  131.  
  132. meblock=n
  133. Default: 1012
  134. Valid values: 128-8192
  135.  
  136. This  keyword specifies the MEMODEM file transfer block size.   Each  block
  137. has a 12 byte header including a crc32 checksum.
  138.  
  139. mestream=string
  140. Default: off
  141. Valid values: on, off
  142.  
  143. This  keyword specifies the MEMODEM files transfer mode.  MEMODEM  supports
  144. paced and streaming modes.
  145.  
  146. merestart=string
  147. Default: off
  148. Valid values: on, off
  149.  
  150. This  keyword specifies the MEMODEM receive restart mode.  MEMODEM supports
  151. restarting at the beginning (off) or after the last valid block (on).
  152.  
  153. meblkdelay=n
  154. Default: 0
  155. Valid values: not validated
  156.  
  157. This  keyword  specifies the MEMODEM delay (in 100th  of  a  second)  place
  158. between blocks.
  159.  
  160. medown=string
  161. Default: current
  162.  
  163. Valid  values:  any  existing DOS directory path (not checked)This  keyword
  164. specifies the default DOS directory for incoming MEMODEM file transfers.
  165.  
  166. meup=string
  167. Default: current
  168. Valid  values:  any  existing DOS directory path (not checked)This  keyword
  169. specifies the default DOS directory for outgoing MEMODEM file transfers.
  170.  
  171.                                 Second Pass
  172.  
  173. flush
  174.  
  175. This keyword instructs COMW to wait for the output buffer to empty.
  176.  
  177. fifo=n
  178. Default: 16
  179. Valid values: 0, 1, 4, 8, 16
  180.  
  181. This keyword instructs COMW to set the fifo mode of a 16550 UART.
  182.  
  183. leave
  184.  
  185. This keyword instructs COMW to leave DTR and RTS on when the program exits.
  186. Normally these are turned off when COMW closes the communications port.
  187.  
  188. delay=n
  189. Default: 0
  190. Valid Values: not validated
  191.  
  192. This  keyword  instructs  COMW  to leave delay  (in  milliseconds)  between
  193. characters  transmitted.   This  options  allow  you  to  slow   down   the
  194. transmissions for modems in command mode.  This delay should be  set  to  0
  195. after the modems connect.
  196.  
  197. out=string
  198.  
  199. This keyword instructs COMW to transmit the characters of the string.   The
  200. contents   of  the  string  wil  be  explained  later.   Note:   characters
  201. transmitted will not be echoed to the popup display.
  202.  
  203. echo=string
  204.  
  205. This  keyword  instructs COMW to send the characters of the string  to  the
  206. popup display.
  207.  
  208. wait=string
  209.  
  210. This  keyword  instructs COMW to wait for a string from the  communications
  211. port (i.e. `ok' or `connect').  COMW compares only the number of characters
  212. in  the  string.   This allows for generic modem responses (i.e.  `connect'
  213. matches `connect 9600' or `connect 9600/ARQ').
  214.  
  215. exit
  216.  
  217. This  keyword instructs COMW to exit back to DOS with an errorlevel  of  0.
  218. COMW closes the communications port and restores the screen under the popup
  219. display.
  220.  
  221. mesendf=string
  222.  
  223. This keyword instructs COMW to start a MEMODEM file transfer send using the
  224. string  as  a  DOS path for a file.  Note: MEMODEM transfer  requests  only
  225. contain  the  DOS  file name, not the complete path.  COMW  on  the  remote
  226. system uses the `medown' keyword to determine where to place the file.
  227.  
  228. megetf=string
  229.  
  230. This keyword instructs COMW to start a MEMODEM file transfer get using  the
  231. string  as  a  DOS path for a file.  Note: MEMODEM transfer  requests  only
  232. contain  the  DOS  file name, not the complete path.  COMW  on  the  remote
  233. system  uses  the `meup' keyword to determine where to place look  for  the
  234. file.
  235.  
  236. doom=string
  237.  
  238. This  keyword  instructs COMW to start ID's DOOM v1.2 using the  string  as
  239. command  line parameters for the game.  COMW will allow you any  speed  and
  240. modem  settings you like.  This will allow you to experiment.  The  buffers
  241. size used by the communications routine is set to 528 bytes and can not  be
  242. changed.  I have obtained the best performance using the maximum speed  the
  243. modems  will  connect using no compression or block protocol (i.e.  MNP  or
  244. V.32bis).  PLEASE NOTE: the communications protocol used by COMW  for  DOOM
  245. is  not compatible with SERSETUP.  Therefore both sides must use COMW.  The
  246. lowlevel communications routine are written in "heads down" assembler.   Do
  247. NOT use XON/XOFF flow control, this will interfere with the protocol.
  248.  
  249.          DOOM, the DOOM logo and DOOM likenesses are trademarks of
  250.                         id Software, inc.,(C)1993.
  251.  
  252. player=n
  253. Default: 0
  254. Valid values: 0, 1
  255.  
  256. This keyword instructs COMW to start the DOOM player negotiations with  the
  257. specified  player number.  Player zero becomes the console for the  network
  258. game  and  should  be  the  player with the faster  computer/communications
  259. port(i.e. 16550 UART).
  260.  
  261. ticdup=n
  262. Default: 1
  263. Valid values: 1-5
  264.  
  265. This  keyword  instructs COMW to set the corresponding value  in  the  DOOM
  266. communications block.  I included this setting for testing purposes and did
  267. not  remove  it  when I was done.  I recommend leaving it  at  the  default
  268. setting.
  269.  
  270. extratics=n
  271. Default: 0
  272. Valid values: 0, 1
  273.  
  274. This  keyword  instructs COMW to set the corresponding value  in  the  DOOM
  275. communications block. I included this setting for testing purposes and  did
  276. not  remove  it  when I was done.  I recommend leaving it  at  the  default
  277. setting.
  278.  
  279. KEYBOARD
  280.  
  281. Standard  ASCII  characters  entered  at  the  keyboard  are  sent  to  the
  282. communications port.  The ESCAPE key however, will cause COMW to exit  back
  283. to  DOS  with an errorlevel of 1.  COMW closes the communications port  and
  284. restores  the screen under the popup display.  In chat mode, the characters
  285. entered  at the keyboard will be echoed in the popup display and COMW  will
  286. add  the  LINE  FEED character after each ENTER character.  The  Alt-c  key
  287. combination will toggle in and out of chat mode.
  288.  
  289. OUT & ECHO STRINGS
  290.  
  291. COMW will perform special functions for the following characters:
  292.  
  293. #
  294. This character will cause COMW to drop the DTR and RTS signals to the modem
  295. for one second (out keyword only).
  296.  
  297. ^
  298. This character will cause COMW to interpret the next character as a control
  299. character  (i.e.  ^m  or  ^M  represents the  enter  character;  ^j  or  ^J
  300. represents the line feed character).
  301.  
  302. ~
  303. This character will cause COMW to delay for 2 tenths of a second.
  304.  
  305. `
  306. This character will cause COMW to transmit it's program ID string.
  307.  
  308.